home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 005 / supermkt.arc / SHOP.DOC < prev   
Encoding:
Text File  |  1986-07-07  |  10.8 KB  |  334 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.                           SHOPPING PROGRAM
  11.  
  12.                             July 7, 1986
  13.  
  14.  
  15.  
  16.      CONTENTS
  17.      --------
  18.  
  19.      DISCLAIMER ...........................................   1
  20.  
  21.      OVERVIEW .............................................   2
  22.  
  23.      USING THE PROGRAM ....................................   3
  24.  
  25.      MISCELLANY ...........................................   4
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.                                                      Page  1
  70.  
  71.      DISCLAIMER
  72.      ----------
  73.  
  74.  
  75.  
  76.  
  77.     We got the idea for this program because my Daughter the
  78.     Shopper found she was making too many trips to the
  79.     supermarket, doing too much impulse buying, and in general
  80.     wasting time and money.  Now she has a handle on what she
  81.     spends, we rarely run out of things, and handle the nuisance
  82.     of grocery shopping more efficiently.  It does look a little
  83.     strange to people, seeing her running around the supermarket
  84.     with a computer printout, but what the heck!
  85.  
  86.     The program is offered to the public as is, and no
  87.     responsibility is assumed for any damage arising from its'
  88.     use.  It is hoped that you find it helpful in the drudgery of
  89.     grocery shopping.
  90.  
  91.     The program runs on a PC Jr, PC/XT, and PC/AT.  It requires
  92.     128k of memory and one diskette drive.  It was written in
  93.     BASIC, using BDS (Basic Development System) under DOS 2.1.  An
  94.     IBM Graphics Printer or equivalent is also required for
  95.     printing the Shopping List.
  96.  
  97.     The source code was originally 31k in length, but BDS was used
  98.     to shorten variable names, combine lines, and delete comment
  99.     lines.  As a result, for debugging purposes, variable name
  100.     meanings will not be obvious.
  101.  
  102.     Although she doesn't intend any further releases or general
  103.     maintenance, if bugs are found, please leave a message on the
  104.     board where you downloaded the program, and if possible,my
  105.     Daughter the Programmer will give you the patch.
  106.  
  107.     One last point - if the program does nothing else, at least
  108.     maybe it'll get the lady of the house involved in the computer
  109.     and perhaps she'll finally understand why you spend so many
  110.     hours on it!
  111.  
  112.  
  113.  
  114.        Harvey Scali - the Father: Eater of the groceries.
  115.  
  116.        Susan Scali  - the Daughter: Chief Coupon Clipper,
  117.                       Programmer, and Shopper par Excellence!
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.                                                      Page  2
  136.  
  137.  
  138.      OVERVIEW
  139.      --------
  140.  
  141.  
  142.     The program lets you create up to 19 shopping categories,
  143.     i.e., DAIRY, PRODUCE, MEATS, CANNED GOODS, etc., as you
  144.     choose.  Within each category you can create up to 20 item
  145.     types - for example, in the DAIRY category you might have
  146.     MILK, EGGS, BUTTER, etc.
  147.  
  148.     There is a 20th category that is pre-set as "OTHER STORES".
  149.     This also allows up to 20 items that you might purchase
  150.     elsewhere - drugstore, gas, etc.  On the printed shopping
  151.     list, this category shows on a separate page.
  152.  
  153.     You can create, change and delete categories and items.  You
  154.     also assign to each item a description, an allocation (how
  155.     many of the item should be on hand), the in-stock position,
  156.     and a price.
  157.  
  158.     There is also a "Statistics" option that shows, within a given
  159.     time period, how many times you shopped for an item, and the
  160.     total number of that item bought.  This is useful in that, if
  161.     you find you shopped for an item 5 times in one month and
  162.     purchased a total of 5 of that item, then your allocation is
  163.     obviously too low and you are wasting time at the store -
  164.     unless, of course it's a perishable item.  Using this option
  165.     requires that you set the date before running this program.
  166.  
  167.     As you use items, you would keep a record and periodically
  168.     update your shopping list in the program.  When you are ready
  169.     to actually do the shopping, you would print the list.  It
  170.     would show the category, the items within the category by
  171.     name,  description, how many to buy, the price, extension, and
  172.     expected total.
  173.  
  174.     When the shopping list is printed, a temporary file is created
  175.     from what was on the list.  After having shopped you would
  176.     update this file with what you actually purchased.  The item
  177.     file would be updated accordingly.
  178.  
  179.     For more efficiency, you can arrange the categories in an
  180.     order that approximates the layout of aisles in the store or
  181.     stores you shop at.  That way the printed list will be such
  182.     that you can literally proceed through the store from one end
  183.     to the other, and not have to jump around on the list or in
  184.     the store.  You can specify as many store layouts as you want.
  185.     They will be kept in their own files.
  186.  
  187.     Initially it will require some work to determine your
  188.     categories and items, to figure what each allocation should
  189.     be, and to know the prices.  Use of the program will give you
  190.     more familiarity with these details, as you shop and note what
  191.     you spend and how often you buy an item.  You can then adjust
  192.     accordingly.
  193.  
  194.     You should back up your files, for safety' sake, and in the
  195.     event that you mess them up with changes, etc., beyond repair.
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.                                                       Page  3
  203.  
  204.  
  205.      USING THE PROGRAM
  206.  
  207.  
  208.  
  209.     When you start the program, you'll be asked for a work file
  210.     drive - the one on which you want your category, item, and
  211.     store layout files to reside.  We use a ram disk for these for
  212.     speed's sake.  However, you can go through the program and
  213.     hardcode a drive if you like, by taking out certain lines.
  214.     See Page 4 for the line numbers.
  215.  
  216.     Empty category and item files will be created the first time
  217.     through the program.  The category file is a 21 record
  218.     sequential file.  Each of the first 20 records contains the
  219.     category name and record number of the first item in that
  220.     category.  The 21st record is the date - see "Statistics",
  221.     above.  The item file is a random file, 17200 bytes in length.
  222.     Although the first item in a category is found randomly, the
  223.     remaining 19 item records are gotten sequentially.  This
  224.     method shortens the access time to an item considerably.
  225.  
  226.     You would then use option 5 on the main menu (FILE
  227.     MAINTENANCE) and proceed to fill in your categories and then
  228.     your items.  Category and item names, and item descriptions
  229.     are restricted to 15 characters each, and a beep will sound if
  230.     you exceed this.  At any point, from the FILE MAINTENANCE
  231.     menu, you can display categories and items, delete/change/add
  232.     categories and items.  The options in the menu are self
  233.     explanatory.  If you delete a category, the corresponding item
  234.     records are also deleted, the categories are "moved up" to
  235.     fill the empty designation, and the item record pointers
  236.     updated accordingly.
  237.  
  238.     From the MAIN menu, Option 1 will let you update - either the
  239.     shopping list or the stock - i.e., as you use items you would
  240.     update the list of what you need to buy.  After you buy them,
  241.     you would update the stock.  The option will lead you
  242.     accordingly.  Option 2 allows you to display or print the
  243.     shopping list.  If you opt to print it, at that point the
  244.     temporary file will be created, which is the input to updating
  245.     the stock (Option 1).  Displaying the list will not cause any
  246.     updates, but merely show you what you need to buy so far.
  247.     Option 3 will allow you to display or print the entire item
  248.     file.  Option 4 is the STATISTICS option.  You will be shown
  249.     the date of the last stock update.  If you want to keep track
  250.     monthly of the statistics, you will be given the option of
  251.     erasing that date.  Your statistics file will then begin again
  252.     when you next update the stock.
  253.  
  254.     Overall, the menus guide you and there is not much need for
  255.     further explanation as to their use.  There are instances
  256.     though, where a single key input will be required, without
  257.     hitting the ENTER key, and others where the ENTER key must be
  258.     pressed.  The latter are where input would possibly be more
  259.     than one character.  All menu options require pressing only
  260.     the number of the option, whereas, looking at a specific
  261.     category or item requires pressing ENTER after the number.
  262.     Any prompts requiring a "yes, no, or quit" answer require only
  263.     pressing the y, n or q keys.  Most null inputs will take you
  264.     back to the previous menu.
  265.  
  266.  
  267.  
  268.  
  269.  
  270.                                                      Page  4
  271.  
  272.  
  273.  
  274.     MISCELLANY
  275.     ----------
  276.  
  277.     There is more to the program than described above, but using
  278.     it will make you familiar with it, rather than supplying a
  279.     lengthy description here.  The following, however is
  280.     information on the files created, and hard-coding a Work
  281.     Drive:
  282.  
  283.                            Files:
  284.                            -----
  285.  
  286.     The files created by the program the first time you invoke it
  287.     are:
  288.           CAT.    -  The Category File  -  sequential
  289.           ITEMS.  -  The Item File  -  random
  290.  
  291.     Printing the shopping list creates the file 'TEMP.' - a
  292.     sequential list of the items and quantities to be purchased.
  293.     Used as input to the stock updating function, and then deleted
  294.     by the program.
  295.  
  296.     Store sequence file - created just prior to printing the
  297.     Shopping List, if you opt to do so.  The program appends the
  298.     prefix  .STR  to the file when you supply the store name.  It
  299.     can be saved and called for before printing the Shopping List.
  300.     Sequence files can be created for as many stores as you like.
  301.     They will be displayed if you ask for an existing Sequence
  302.     file, and you would choose the particular one at that time.
  303.     The shopping list would then print in that store's aisle
  304.     sequence.
  305.  
  306.  
  307.     Hard-Coding the Work Drive:
  308.     --------------------------
  309.  
  310.     All the files named above must reside on the work drive.  To
  311.     hard-code the work drive, rather than having the initial
  312.     prompt for a drive letter come up each time you run the
  313.     program, remove lines 20, 30, and 40 (the Prompt statements).
  314.  
  315.     Next, change the variable  DRV$  to the drive and a colon -
  316.     i.e., 'c:'.  For example, the statement
  317.  
  318.                OPEN DRV$+"items" as #1
  319.  
  320.     would be changed to read
  321.  
  322.                OPEN "c:items" as #1
  323.  
  324.     The line numbers to change are:
  325.  
  326.       50, 60, 1130, 1140, 1490, 1570, 1670, 2050 (3), 2140,
  327.       2470, 2590, 2610, 2630, 2670, 2710, 2930 (2), 3110 (2)
  328.  
  329.     where the number in parentheses indicates the number of times
  330.     the variable  DRV$  appears in that line.
  331.  
  332.  
  333.                          HAPPY SHOPPING!!
  334.